Skip to content

docs(updater): document --url option for offline/air-gapped installs#14846

Open
skjnldsv wants to merge 4 commits into
masterfrom
docs/updater-url-option
Open

docs(updater): document --url option for offline/air-gapped installs#14846
skjnldsv wants to merge 4 commits into
masterfrom
docs/updater-url-option

Conversation

@skjnldsv
Copy link
Copy Markdown
Member

@skjnldsv skjnldsv commented May 13, 2026

1 2
2026-05-13_16-11 2026-05-13_16-11_1

☑️ Resolves

Relates to the --url option added to updater.phar.

What changed and why

Adds a new section "Using a custom download URL (offline / air-gapped installs)" to admin_manual/maintenance/update.rst.

The updater.phar supports a --url option that lets admins point the updater at any HTTP/HTTPS or file:// URL instead of the official download servers. This is useful for:

  • Air-gapped / offline environments where the server has no internet access
  • Internal mirrors in enterprise setups

The section covers:

  • --url with HTTP/HTTPS mirror example
  • --url with file:// for locally staged archives
  • --signature to supply the base64 archive signature when using a custom URL
  • --no-verify as an escape hatch (with a warning)
  • Combined --no-interaction example for fully automated offline runs

🖼️ Screenshots

No visual regressions — new prose section with code blocks only.

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

Covers --url (HTTP/HTTPS and file://), --signature for providing
a base64 archive signature, --no-verify as escape hatch, and
combining all three with --no-interaction for automated runs.

Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
skjnldsv added 2 commits May 13, 2026 15:57
Covers pinning a specific version, internal mirrors, and offline/
air-gapped use via file://. Includes --signature and --no-verify
options with appropriate warnings.

Warns explicitly that downgrading and skipping major versions remain
unsupported regardless of --url usage.

Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 13, 2026

📖 Documentation Preview

🔍 Open preview →

📄 1 changed documentation page

Last updated: Wed, 13 May 2026 14:26:17 GMT

Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant